Content Library Subscriptions CreateSpecPlacement

Content Library Subscriptions CreateSpecPlacement
Content Library Subscriptions CreateSpecPlacement

The Content Library Subscriptions CreateSpecPlacement schema defines the placement information for the subscribed library's virtual machine template library items. Storage location of the virtual machine template items is defined by the subscribed library's storage backing. This placement information needs to be compatible with the subscribed library's storage backing. The Content Library Subscriptions CreateSpecPlacement schema is only applicable for the virtual machine template library items of the subscribed library.

This schema was added in vSphere API 6.7.2.

JSON Example
{
    "folder": "string",
    "cluster": "string",
    "resource_pool": "string",
    "host": "string",
    "network": "string"
}
string
folder
Optional

Virtual machine folder into which the virtual machine template should be placed.

This property was added in vSphere API 6.7.2.

This property is currently required. In future, if this is missing or null, the system will attempt to choose a suitable folder for the virtual machine template; if a folder cannot be chosen, publishing a virtual machine template item will fail.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder:VCenter.

string
cluster
Optional

Cluster onto which the virtual machine template should be placed. If cluster and resource_pool are both specified, resource_pool must belong to cluster. If cluster and host are both specified, host must be a member of cluster.

This property was added in vSphere API 6.7.2.

If resource_pool or host is specified, it is recommended that this property be missing or null.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource:VCenter.

string
resource_pool
Optional

Resource pool into which the virtual machine template should be placed. If host and resource_pool are both specified, resource_pool must belong to host. If cluster and resource_pool are both specified, resource_pool must belong to cluster.

This property was added in vSphere API 6.7.2.

This property is currently required. In future, if this is missing or null, the system will attempt to choose a suitable resource pool for the virtual machine template; if a resource pool cannot be chosen, publish of virtual machine template item will fail.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool:VCenter.

string
host
Optional

Host onto which the virtual machine template should be placed. If host and resource_pool are both specified, resource_pool must belong to host. If host and cluster are both specified, host must be a member of cluster.

This property was added in vSphere API 6.7.2.

If this is missing or null, the system will attempt to choose a suitable host for the virtual machine template; if a host cannot be chosen, publishing the virtual machine template item will fail.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem:VCenter.

string
network
Optional

Network that backs the virtual Ethernet adapters in the virtual machine template.

This property was added in vSphere API 6.7.2.

If missing or null, the virtual Ethernet adapters will not be backed by a network.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Network:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Network:VCenter.